Migration guide from external idp to embedded idp#658
Open
Conversation
7 tasks
TechHutTV
reviewed
Mar 18, 2026
| 6. Under **Token Settings**, enable both: | ||
| - User roles inside ID token | ||
| - User Info inside ID token | ||
| 7. Create a `connector.json` file: |
TechHutTV
reviewed
Mar 18, 2026
| - **Type:** Web | ||
| - **Authentication Method:** Code | ||
| 4. Set the redirect URI to `https://<your-management-domain>/oauth2/callback`. | ||
| 5. Save and copy the **Client ID** and **Client Secret**. |
Collaborator
There was a problem hiding this comment.
... after creating the new application.
TechHutTV
reviewed
Mar 18, 2026
Comment on lines
+122
to
+158
| "redirectURI": "https://<your-management-domain>/oauth2/callback" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You will pass this file in Step 5 with the `--idp-seed-info` flag. | ||
|
|
||
| See also: [Zitadel setup guide](/selfhosted/identity-providers/zitadel). | ||
|
|
||
| ### Custom / Unsupported Provider (JumpCloud, etc.) | ||
|
|
||
| For providers without built-in detection, create a generic OIDC `connector.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "type": "oidc", | ||
| "name": "My Provider", | ||
| "id": "my-provider", | ||
| "config": { | ||
| "issuer": "https://idp.example.com", | ||
| "clientID": "my-client-id", | ||
| "clientSecret": "my-client-secret", | ||
| "redirectURI": "https://<your-management-domain>/oauth2/callback" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You will pass this file in Step 5 with the `--idp-seed-info` flag. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 3: Stop the Management Server | ||
|
|
||
| **Systemd / bare-metal:** | ||
|
|
||
| ```bash | ||
| sudo systemctl stop netbird-management |
Collaborator
There was a problem hiding this comment.
I don't think anyone really runs this without docker
TechHutTV
reviewed
Mar 18, 2026
Comment on lines
+122
to
+198
| "redirectURI": "https://<your-management-domain>/oauth2/callback" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You will pass this file in Step 5 with the `--idp-seed-info` flag. | ||
|
|
||
| See also: [Zitadel setup guide](/selfhosted/identity-providers/zitadel). | ||
|
|
||
| ### Custom / Unsupported Provider (JumpCloud, etc.) | ||
|
|
||
| For providers without built-in detection, create a generic OIDC `connector.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "type": "oidc", | ||
| "name": "My Provider", | ||
| "id": "my-provider", | ||
| "config": { | ||
| "issuer": "https://idp.example.com", | ||
| "clientID": "my-client-id", | ||
| "clientSecret": "my-client-secret", | ||
| "redirectURI": "https://<your-management-domain>/oauth2/callback" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You will pass this file in Step 5 with the `--idp-seed-info` flag. | ||
|
|
||
| --- | ||
|
|
||
| ## Step 3: Stop the Management Server | ||
|
|
||
| **Systemd / bare-metal:** | ||
|
|
||
| ```bash | ||
| sudo systemctl stop netbird-management | ||
| ``` | ||
|
|
||
| **Docker Compose:** | ||
|
|
||
| ```bash | ||
| docker compose stop management | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Step 4: Back Up Your Data | ||
|
|
||
| The tool creates `management.json.bak` automatically, but always make your own backups. | ||
|
|
||
| <Warning> | ||
| Do not skip this step. The migration modifies user IDs in the database. A manual backup is your only recovery path if something goes wrong. | ||
| </Warning> | ||
|
|
||
| **Systemd / bare-metal (SQLite):** | ||
|
|
||
| ```bash | ||
| cp /var/lib/netbird/store.db /var/lib/netbird/store.db.bak | ||
| cp /etc/netbird/management.json /etc/netbird/management.json.bak | ||
| ``` | ||
|
|
||
| **Docker Compose (SQLite in a named volume):** | ||
|
|
||
| ```bash | ||
| # Identify the volume name | ||
| VOLUME_NAME=$(docker volume ls --format '{{ .Name }}' | grep -i management) | ||
| echo "Volume: $VOLUME_NAME" | ||
|
|
||
| # Get the host path | ||
| VOLUME_PATH=$(docker volume inspect "$VOLUME_NAME" --format '{{ .Mountpoint }}') | ||
| echo "Path: $VOLUME_PATH" | ||
|
|
||
| # Verify store.db exists, then back up | ||
| sudo ls "$VOLUME_PATH/store.db" | ||
| sudo cp "$VOLUME_PATH/store.db" "$VOLUME_PATH/store.db.bak" | ||
| cp ~/netbird/management.json ~/netbird/management.json.bak |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.